全部产品

产品文档

API

下载

示例代码

FAQ

API 概览

API 详情

错误码列表

Class

Class 概览

Class 详情

Protocl

Protocol 概览

Protocol 详情

Enum

Enum 概览

Enum 详情

开发者中心

全部产品

API

iOS 直播 ToB

Enum 详情

更新时间：2023-10-10 11:53:05

KRtcEngineWarningCode

SDK 警告码。

Declared in KRtcEngineEnumerates.h

KRtcEngineWarningCodeNetworkNotGood

KRtcEngineWarningCodeNetworkNotGood=(5)

详情描述: 当前网络状况不好，可能导致推流卡顿。

KRtcEngineWarningCodeFallbackToSoftVideoEncoder

KRtcEngineWarningCodeFallbackToSoftVideoEncoder=(162)

详情描述: 视频编码器从硬编回退到软编。

KRtcEngineErrorCode

SDK 错误码。

Declared in KRtcEngineEnumerates.h

KRtcEngineErrorCodeFailedDecodePushedImage

KRtcEngineErrorCodeFailedDecodePushedImage=(159)

详情描述: 无法解码 APP 通过 startPushImage 设置的图片。

KRtcEngineErrorCodeFailedDecodeWatermarkImage

KRtcEngineErrorCodeFailedDecodeWatermarkImage=(160)

详情描述: 无法解码 APP 通过 AddWatermark 接口设置的图片。

KRtcEngineErrorCodeFailedOpenCamera

KRtcEngineErrorCodeFailedOpenCamera=(301)

详情描述: 摄像头打开失败。

KRtcEngineErrorCodeFailedOpenMicrophone

KRtcEngineErrorCodeFailedOpenMicrophone=(302)

详情描述: 麦克风打开失败。

KRtcEngineVideoOutputOrientationMode

手机横竖屏模式。

Declared in KRtcEngineEnumerates.h

KRtcEngineVideoOutputOrientationModeAdaptive

KRtcEngineVideoOutputOrientationModeAdaptive=(0)

详情描述: （默认）该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转。该模式适用于接收端可以调整视频方向的场景。如果采集的视频是横屏模式，则输出的视频也是横屏模式；如果采集的视频是竖屏模式，则输出的视频也是竖屏模式。

KRtcEngineVideoOutputOrientationModeFixedLandscape

KRtcEngineVideoOutputOrientationModeFixedLandscape=(1)

详情描述: 该模式下 SDK 固定输出风景（横屏）模式的视频。如果采集到的视频是竖屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用 CDN 推流场景下。

KRtcEngineVideoOutputOrientationModeFixedPortrait

KRtcEngineVideoOutputOrientationModeFixedPortrait=(2)

详情描述: 该模式下 SDK 固定输出人像（竖屏）模式的视频，如果采集到的视频是横屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用 CDN 推流场景下。

KRtcEngineLogLevel

KRTC SDK 的日志输出等级。

Declared in KRtcEngineEnumerates.h

KRtcEngineLogLevelDebug

KRtcEngineLogLevelDebug=(0)

详情描述: 不输出任何日志。

KRtcEngineLogLevelInfo

KRtcEngineLogLevelInfo=(1)

详情描述: （默认）输出 KLogLevelFatal、KLogLevelError、KLogLevelWarn、KLogLevelInfo 级别的日志。我们推荐你将日志级别设为该等级。

KRtcEngineLogLevelWarn

KRtcEngineLogLevelWarn=(2)

详情描述: 仅输出 KLogLevelFatal、KLogLevelError、KLogLevelWarn 级别的日志。

KRtcEngineLogLevelError

KRtcEngineLogLevelError=(3)

详情描述: 仅输出 KLogLevelFatal、KLevelError 级别的日志。

KRtcEngineLogLevelNone

KRtcEngineLogLevelNone=(4)

详情描述: 不输出任何日志。

KRtcEngineLiveAudioProfile

音频编码参数。

Declared in KRtcEngineEnumerates.h

KRtcEngineLiveAudioProfileSpeechDefault

KRtcEngineLiveAudioProfileSpeechDefault=(0)

详情描述: 默认，双声道，采样率44100Hz，码率64kbps。

KRtcEngineLiveAudioProfileMusicStandardStereo

KRtcEngineLiveAudioProfileMusicStandardStereo=(1)

详情描述: 音乐编码，双声道，采样率48000Hz，码率48kbps。

KRtcEngineLiveAudioProfileMusicHighQualityStereo

KRtcEngineLiveAudioProfileMusicHighQualityStereo=(2)

详情描述: 高音质音乐编码，双声道，采样率48000Hz，码率64kbps。

KRtcEngineLiveAudioProfileMusicHigherQualityStereo

KRtcEngineLiveAudioProfileMusicHigherQualityStereo=(3)

详情描述: 96K音质音乐编码，双声道，采样率48000Hz，码率96kbps。

KRtcEngineLiveAudioProfileMusicVeryHighQualityStereo

KRtcEngineLiveAudioProfileMusicVeryHighQualityStereo=(4)

详情描述: 128K音质音乐编码，双声道，采样率48000Hz，码率128kbps。

KRtcEngineVoiceEffectOption

音效选项

Declared in KRtcEngineEnumerates.h

KRtcEngineVeoNone

KRtcEngineVeoNone=(0)

详情描述: 原声，即关闭人声音效

KRtcEngineVeoEcho

KRtcEngineVeoEcho=(1)

详情描述: 回声

KRtcEngineVeoThriller

KRtcEngineVeoThriller=(2)

详情描述: 惊险

KRtcEngineVeoRobot

KRtcEngineVeoRobot=(3)

详情描述: 机器人

KRtcEngineVeoLorie

KRtcEngineVeoLorie=(4)

详情描述: 萝莉

KRtcEngineVeoUncle

KRtcEngineVeoUncle=(5)

详情描述: 大叔

KRtcEngineVeoDieFat

KRtcEngineVeoDieFat=(6)

详情描述: DieFat

KRtcEngineVeoBadBoy

KRtcEngineVeoBadBoy=(7)

详情描述: 坏男孩

KRtcEngineVeoXiaoHuangRen

KRtcEngineVeoXiaoHuangRen=(8)

详情描述: 小黄人

KRtcEngineVeoXiaoHeavyMetal

KRtcEngineVeoXiaoHeavyMetal=(9)

详情描述: 重金属

KRtcEngineVeoDenon

KRtcEngineVeoDenon=(10)

详情描述: Denon

KRtcEngineVeoHeavyMechinery

KRtcEngineVeoHeavyMechinery=(11)

详情描述: 重型机器

KRtcEngineVeoPowerCurrent

KRtcEngineVeoPowerCurrent=(12)

详情描述: 强电流

KRtcEngineVeoCute

KRtcEngineVeoCute=(13)

详情描述: 可爱

KRtcEngineVeoPilot

KRtcEngineVeoPilot=(14)

详情描述: 飞行员

KRtcEngineVeoUserDefine

KRtcEngineVeoUserDefine=(15)

详情描述: 用户自定义

KRtcEngineVeoVibrato

KRtcEngineVeoVibrato=(16)

详情描述: 颤音

KRtcEngineVeoBoy

KRtcEngineVeoBoy=(17)

详情描述: 男孩

KRtcEngineWaWaYin

KRtcEngineWaWaYin=(18)

详情描述: 娃娃音

KRtcEngineReverbLevel

混响选项

Declared in KRtcEngineEnumerates.h

KRtcEngineReverbNone

KRtcEngineReverbNone=(0)

详情描述: 无

KRtcEngineReverbChorus

KRtcEngineReverbChorus=(1)

详情描述: 合唱

KRtcEngineReverbClassic

KRtcEngineReverbClassic=(2)

详情描述: 经典

KRtcEngineReverbPop

KRtcEngineReverbPop=(3)

详情描述: 流行

KRtcEngineReverbHeavy

KRtcEngineReverbHeavy=(4)

详情描述: 重低音

KRtcEngineReverbReverb

KRtcEngineReverbReverb=(5)

详情描述: 混响

KRtcEngineReverbKTV

KRtcEngineReverbKTV=(6)

详情描述: KTV

KRtcEngineReverbBathRoom

KRtcEngineReverbBathRoom=(7)

详情描述: 浴室

KRtcEngineReverbRecord

KRtcEngineReverbRecord=(8)

详情描述: 原声

KRtcEngineReverbStudio

KRtcEngineReverbStudio=(9)

详情描述: 录音棚

KRtcEngineReverbStage

KRtcEngineReverbStage=(10)

详情描述: 舞台

KRtcEngineReverbConcert

KRtcEngineReverbConcert=(11)

详情描述: 音乐会

KRtcEngineReverbLight

KRtcEngineReverbLight=(12)

详情描述: 空灵

KRtcEngineReverbSuperStar

KRtcEngineReverbSuperStar=(13)

详情描述: 巨星

KRtcEngineReverbAmazing

KRtcEngineReverbAmazing=(14)

详情描述: 魔幻

KRtcEngineReverbAmazing2

KRtcEngineReverbAmazing2=(15)

详情描述: 鬼畜

KRtcEngineReverbOldTimeRadio

KRtcEngineReverbOldTimeRadio=(16)

详情描述: 老电台

KRtcEngineVideoRenderMode

”视频渲染模式。"

Declared in KRtcEngineEnumerates.h

KRtcEngineVideoRenderModeFitWithCropping

KRtcEngineVideoRenderModeFitWithCropping=(0)

详情描述: 优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，多出的视频将被截掉。

KRtcEngineVideoRenderModeScaleToFit

KRtcEngineVideoRenderModeScaleToFit=(1)

详情描述: 优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同，视窗上未被填满的区域将被涂黑。

KRtcEngineVideoMirrorMode

镜像模式。

Declared in KRtcEngineEnumerates.h

KRtcEngineVideoMirrorModeAuto

KRtcEngineVideoMirrorModeAuto=(0)

详情描述: （默认）由 SDK 决定镜像模式，前置摄像头镜像，后置摄像头不镜像。

KRtcEngineVideoMirrorModeEnabled

KRtcEngineVideoMirrorModeEnabled=(1)

详情描述: 前后摄像头都开启镜像模式。

KRtcEngineVideoMirrorModeDisabled

KRtcEngineVideoMirrorModeDisabled=(2)

详情描述: 前后摄像头都关闭镜像模式。

KRtcEngineVideoSourceType

视频源类型。

Declared in KRtcEngineEnumerates.h

KRtcEngineVideoSourceTypePeople

KRtcEngineVideoSourceTypePeople=(0)

详情描述: 视频源为手机摄像头采集数据。

KRtcEngineVideoSourceTypeContent

KRtcEngineVideoSourceTypeContent=(1)

详情描述: 视频源为手机抓屏数据。

KRtcEngineBackgroundMode

App 退后台后的音视频推流模式。

Declared in KRtcEngineEnumerates.h

KRtcEngineBackgroundModeKeepLastFrame

KRtcEngineBackgroundModeKeepLastFrame=(0)

详情描述: App 退后台推的视频流为退后台之前的最后一个视频帧，音频为静音数据。

KRtcEngineBackgroundModeBlackStreaming

KRtcEngineBackgroundModeBlackStreaming=(1)

详情描述: App 退后台推的视频流为黑屏，音频为静音数据。

KRtcEngineBackgroundModeNormalStreaming

KRtcEngineBackgroundModeNormalStreaming=(2)

详情描述: App 退后台仍然正常推音视频流，常用于屏幕推流。

KRtcEngineBackgroundModeBreakStreaming

KRtcEngineBackgroundModeBreakStreaming=(3)

详情描述: App 退后台，不推任何音视频数据。

KRtcEnginePushStreamState

直播推流状态。

Declared in KRtcEngineEnumerates.h

KRtcEnginePushStreamStateInvalid

KRtcEnginePushStreamStateInvalid=(-1)

详情描述: 无效状态，频道不存在。

KRtcEnginePushStreamStateIdle

KRtcEnginePushStreamStateIdle=(0)

详情描述: 初始状态，即推流尚未开始。

KRtcEnginePushStreamStateRunning

KRtcEnginePushStreamStateRunning=(1)

详情描述: 正在推流中，当调用 startPush 成功推流时，sdk 会返回该值。

KRtcEnginePushStreamStateStopped

KRtcEnginePushStreamStateStopped=(2)

详情描述: 推流已正常结束，当调用 stopPush 主动停止推流时，SDK会返回该值。

KRtcEnginePushStreamStateFailed

KRtcEnginePushStreamStateFailed=(3)

详情描述: 推流失败，可以通过 onPushStreamStateChanged 回调报告的信息排查问题，然后重新推流。

KRtcEnginePushStreamStateRecovering

KRtcEnginePushStreamStateRecovering=(4)

详情描述: 尝试重新连接Aray服务器和CDN，最多尝试重连3次，每次10秒。如仍未成功恢复连接，则推流状态变为 kFailed。

KRtcEnginePushStreamError

直播推流错误码。

Declared in KRtcEngineEnumerates.h

KRtcEnginePushStreamErrorOk

KRtcEnginePushStreamErrorOk=(0)

详情描述: 推流状态正常。

KRtcEnginePushStreamErrorFailed

KRtcEnginePushStreamErrorFailed=(1)

详情描述: 一般性错误，没有明确原因。你可以尝试重新推流。

KRtcEnginePushStreamErrorAudioPublication

KRtcEnginePushStreamErrorAudioPublication=(2)

详情描述: 音频推流出错。例如，本地音频采集设备未正常工作、被其他进程占用或没有使用权限。

KRtcEnginePushStreamErrorVideoPublication

KRtcEnginePushStreamErrorVideoPublication=(3)

详情描述: 视频推流出错。例如，本地视频采集设备未正常工作、被其他进程占用或没有使用权限。

KRtcEnginePushStreamErrorNetConnect

KRtcEnginePushStreamErrorNetConnect=(4)

详情描述: 网络连接失败。

KRtcEnginePushStreamErrorBadName

KRtcEnginePushStreamErrorBadName=(5)

详情描述: URL 已用于推流，请使用新的 URL。

KRtcEnginePushStreamErrorAuthenticationFailed

KRtcEnginePushStreamErrorAuthenticationFailed=(6)

详情描述: 鉴权失败，比如被禁推或者 token 错误等。

KRtcEngineNetworkQuality

网络质量

Declared in KRtcEngineEnumerates.h

KRtcEngineNetworkQualityUnknown

KRtcEngineNetworkQualityUnknown=(0)

详情描述: 未知

KRtcEngineNetworkQualityExcellent

KRtcEngineNetworkQualityExcellent=(1)

详情描述: 非常好

KRtcEngineNetworkQualityGood

KRtcEngineNetworkQualityGood=(2)

详情描述: 较好

KRtcEngineNetworkQualityPoor

KRtcEngineNetworkQualityPoor=(3)

详情描述: 一般

KRtcEngineNetworkQualityBad

KRtcEngineNetworkQualityBad=(4)

详情描述: 不好

KRtcEngineNetworkQualityVBad

KRtcEngineNetworkQualityVBad=(5)

详情描述: 非常不好

KRtcEngineNetworkQualityUnavailable

KRtcEngineNetworkQualityUnavailable=(6)

详情描述: 不可用

KRtcEngineAudioFrameFormat

音频帧格式。

Declared in KRtcEngineEnumerates.h

KRtcEngineAudioFrameFormatPcmS16Le

KRtcEngineAudioFrameFormatPcmS16Le=(0)

详情描述: 16位有符号小字节序

KRtcEngineVideoFrameFormat

视频帧格式。

Declared in KRtcEngineEnumerates.h

KRtcEngineVideoFrameFormatYUVI420

KRtcEngineVideoFrameFormatYUVI420=(0)

详情描述: I420 格式的 YUV 数据。